<!-- HTML header for doxygen 1.8.4-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
		<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
		<meta http-equiv="X-UA-Compatible" content="IE=9"/>
		<meta name="generator" content="Doxygen 1.8.4"/>
		<title>exceptions4c: e4c_exception_type Struct Reference</title>
		<link href="tabs.css" rel="stylesheet" type="text/css"/>
		<link href="exceptions4c.css" rel="stylesheet" type="text/css" />
		<!-- <link href="sheep_016.png" rel="shortcut icon" /> -->
		<link href="" rel="shortcut icon">
		<script type="text/javascript" src="jquery.js"></script>
		<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
		<link href="exceptions4c.css" rel="stylesheet" type="text/css" />
	</head>
	<body>
		<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
				<div id="titlearea">
					<table cellspacing="0" cellpadding="0">
						<tbody>
							<tr style="height: 56px;">
									<td id="projectlogo"><img alt="Logo" src="sheep_064.png"/></td>
									<td style="padding-left: 0.5em;">
										<div id="projectname">
											exceptions4c
											&nbsp;
											<span id="projectnumber">version 3.0</span>
										</div>
											<div id="projectbrief">An exception handling framework for C</div>
									</td>
							</tr>
						</tbody>
				</table>
			</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structe4c__exception__type.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">e4c_exception_type Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Represents an exception type in the exception handling system.  
 <a href="structe4c__exception__type.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ad24b0319477d4d408f64e78d3c0c4e23"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structe4c__exception__type.html#ad24b0319477d4d408f64e78d3c0c4e23">name</a></td></tr>
<tr class="memdesc:ad24b0319477d4d408f64e78d3c0c4e23"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of this exception type.  <a href="#ad24b0319477d4d408f64e78d3c0c4e23">More...</a><br/></td></tr>
<tr class="separator:ad24b0319477d4d408f64e78d3c0c4e23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5680b05e300eae591ed695ee7115a680"><td class="memItemLeft" align="right" valign="top">const char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structe4c__exception__type.html#a5680b05e300eae591ed695ee7115a680">default_message</a> [<a class="el" href="e4c_8h.html#a221e306037ef73b1788ddd261088230f">E4C_EXCEPTION_MESSAGE_SIZE</a>]</td></tr>
<tr class="memdesc:a5680b05e300eae591ed695ee7115a680"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default message of this exception type.  <a href="#a5680b05e300eae591ed695ee7115a680">More...</a><br/></td></tr>
<tr class="separator:a5680b05e300eae591ed695ee7115a680"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec2369585934bc51da05e1885ac6526c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structe4c__exception__type.html">e4c_exception_type</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structe4c__exception__type.html#aec2369585934bc51da05e1885ac6526c">supertype</a></td></tr>
<tr class="memdesc:aec2369585934bc51da05e1885ac6526c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The supertype of this exception type.  <a href="#aec2369585934bc51da05e1885ac6526c">More...</a><br/></td></tr>
<tr class="separator:aec2369585934bc51da05e1885ac6526c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents an exception type in the exception handling system. </p>
<p>The types of the exceptions a program will use are <b>defined</b> in source code files through the macro <code><a class="el" href="e4c_8h.html#aadc9f577bd369729df5aa614e54eedd8" title="Defines an exception type. ">E4C_DEFINE_EXCEPTION</a></code>. In addition, they are <b>declared</b> in header files through the macro <code><a class="el" href="e4c_8h.html#afbe55946f07a3dca22879ad5832b2a19" title="Declares an exception type. ">E4C_DECLARE_EXCEPTION</a></code>.</p>
<p>When defining types of exceptions, they are given a <em>name</em>, a <em>default message</em> and a <em>supertype</em> to organize them into a <em>pseudo-hierarchy</em>:</p>
<div class="fragment"><div class="line"><a class="code" href="e4c_8h.html#aadc9f577bd369729df5aa614e54eedd8" title="Defines an exception type. ">E4C_DEFINE_EXCEPTION</a>(SimpleException, <span class="stringliteral">&quot;Simple exception&quot;</span>, RuntimeException);</div>
</div><!-- fragment --><p>Exceptions are defined as global objects. There is a set of predefined exceptions built into the framework; <code><a class="el" href="e4c_8h.html#a07da936a74602281d601c171b77bf0b0" title="This is the root of the exception pseudo-hierarchy ">RuntimeException</a></code> is the <em>root</em> of the exceptions <em>pseudo-hierarchy</em>:</p>
<ul>
<li><code><a class="el" href="e4c_8h.html#a07da936a74602281d601c171b77bf0b0" title="This is the root of the exception pseudo-hierarchy ">RuntimeException</a></code><ul>
<li><code><a class="el" href="e4c_8h.html#add75d60a1beb6be775c7199b58c8bf49" title="This exception is thrown when the system runs out of memory. ">NotEnoughMemoryException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#a64df4b96937a949466d55b5638c5b9cf" title="This exception is thrown when an assertion does not hold. ">AssertionException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#a1e4eb23ca08a70129f1a5076f37dce3e" title="This exception is thrown when a function is passed an illegal or inappropriate argument. ">IllegalArgumentException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#a4ee8b42ef10e5adf967761811823150c" title="This exception is thrown when an input/output error occurs. ">InputOutputException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#a7ad6290493086138a1d40a5d79cfed17" title="This exception is the common supertype of all signal exceptions. ">SignalException</a></code><ul>
<li><code><a class="el" href="e4c_8h.html#af7c8a584138805cdd58fc268fc8125a8" title="This exception is thrown when a time limit has elapsed. ">SignalAlarmException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#aa9705f1bf72752040cb1faefd741af75" title="This exception is thrown when a child process terminates. ">SignalChildException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#a14e2d961b990ea9b03bc867c7c7236df" title="This exception is thrown when a condition arises that a debugger has requested to be informed of...">SignalTrapException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#ab7b4334cedd9dd92aa16f583dabd94d0" title="This exception is the common supertype of all error signal exceptions. ">ErrorSignalException</a></code><ul>
<li><code><a class="el" href="e4c_8h.html#a1f8767c09f8776465bab2fbf17e178dd" title="This exception is thrown when the process attempts to execute an illegal instruction. ">IllegalInstructionException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#a6fcf200100e1cfde147d444aefe5cdb5" title="This exception is thrown when the process performs an erroneous arithmetic operation. ">ArithmeticException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#a14d711083b9740a7188cbe9f2f915d4f" title="This exception is thrown when the process attempts to write to a broken pipe. ">BrokenPipeException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#aae2c0f060628a75c117ff4bf75f2804f" title="This exception is thrown when the process tries to dereference an invalid pointer. ">BadPointerException</a></code><ul>
<li><code><a class="el" href="e4c_8h.html#ae3f89b7484efca7715d70a781d2856a8" title="This exception is thrown when an unexpected null pointer is found. ">NullPointerException</a></code></li>
</ul>
</li>
</ul>
</li>
<li><code><a class="el" href="e4c_8h.html#a68c1b7bb934db83c6b996a535b5dbc95" title="This exception is the common supertype of all control signal exceptions. ">ControlSignalException</a></code><ul>
<li><code><a class="el" href="e4c_8h.html#a94f5ec0761d8c1dc9a8d2355f1348570" title="This exception is thrown to stop the process for later resumption. ">StopException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#a6af0a9ec525ab5af8a4442a79dcaca70" title="This exception is thrown to terminate the process immediately. ">KillException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#a4766c592882555f4091cb9060f10ab5c" title="This exception is thrown when the process&#39; terminal is closed. ">HangUpException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#a85b12608ec4e14046622ebcaf38b925e" title="This exception is thrown to request the termination of the process. ">TerminationException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#aa5e036c578fdf7577287f547cbc75234" title="This exception is thrown to abort the process. ">AbortException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#a51e3faa8033827a201cb162c52191a84" title="This exception is thrown when the process has used up the CPU for too long. ">CPUTimeException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#afe03611168e7eed8a894066663f3e41e" title="This exception is the common supertype of all control signal exceptions caused by the user...">UserControlSignalException</a></code><ul>
<li><code><a class="el" href="e4c_8h.html#a11a68cf0fcba3fb1a2dd7250d7ceed8c" title="This exception is thrown when the user requests to quit the process. ">UserQuitException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#a7ae85ae6281b40b4419ae8ac4cc6623b" title="This exception is thrown when the user requests to interrupt the process. ">UserInterruptionException</a></code></li>
<li><code><a class="el" href="e4c_8h.html#ac349a1072bfaf69546a8eee5ecd48974" title="This exception is thrown when a user wishes to break the process. ">UserBreakException</a></code></li>
</ul>
</li>
</ul>
</li>
<li><code><a class="el" href="e4c_8h.html#af41f0d1ad6046025d27c75003a453081" title="This exception is the common supertype of all user-defined signal exceptions. ">ProgramSignalException</a></code><ul>
<li><code><a class="el" href="e4c_8h.html#ad99590ee7828c20bdd516ac0fb3cbd48" title="This exception is thrown when user-defined conditions occur. ">ProgramSignal1Exception</a></code></li>
<li><code><a class="el" href="e4c_8h.html#aa262dd222a7bab5d046081ab04a39b17" title="This exception is thrown when user-defined conditions occur. ">ProgramSignal2Exception</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structe4c__exception.html" title="Represents an instance of an exception type. ">e4c_exception</a> </dd>
<dd>
<a class="el" href="e4c_8h.html#aadc9f577bd369729df5aa614e54eedd8" title="Defines an exception type. ">E4C_DEFINE_EXCEPTION</a> </dd>
<dd>
<a class="el" href="e4c_8h.html#afbe55946f07a3dca22879ad5832b2a19" title="Declares an exception type. ">E4C_DECLARE_EXCEPTION</a> </dd>
<dd>
<a class="el" href="e4c_8h.html#a482d649fcaafd28584629da3606e4ea7" title="Signals an exceptional situation represented by an exception object. ">throw</a> </dd>
<dd>
<a class="el" href="e4c_8h.html#a629585c5169ebdb440b9015f8e87b4df" title="Introduces a block of code capable of handling a specific type of exceptions. ">catch</a> </dd></dl>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a5680b05e300eae591ed695ee7115a680"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char e4c_exception_type::default_message[<a class="el" href="e4c_8h.html#a221e306037ef73b1788ddd261088230f">E4C_EXCEPTION_MESSAGE_SIZE</a>]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The default message of this exception type. </p>

</div>
</div>
<a class="anchor" id="ad24b0319477d4d408f64e78d3c0c4e23"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* e4c_exception_type::name</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The name of this exception type. </p>

</div>
</div>
<a class="anchor" id="aec2369585934bc51da05e1885ac6526c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="structe4c__exception__type.html">e4c_exception_type</a>* e4c_exception_type::supertype</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The supertype of this exception type. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="e4c_8h.html">e4c.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.4-->
<!-- start footer part -->
			<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
			  <ul>
				<li class="navelem"><a class="el" href="structe4c__exception__type.html">e4c_exception_type</a></li>
				<li class="footer">
					<a href="https://code.google.com/p/exceptions4c/" title="exceptions4c version 3.0">
						<img src="sheep_016.png" width="16" height="16" alt="" style="vertical-align: text-bottom;" />
						<strong>exceptions4c</strong>
					</a>
					Reference Documentation
					Generated by
					<a href="http://www.doxygen.org/index.html" title="doxygen 1.8.4">
						<strong>doxygen</strong>
					</a>
				</li>
			  </ul>
			</div>
	</body>
</html>
